home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / SUPERA.ZIP;1 / README.SM < prev    next >
Encoding:
Text File  |  1992-04-15  |  15.3 KB  |  334 lines
  1. *********************[ Programmer's SUPER-MAINT ]***************************
  2. ***************************[ version 3.00 ]*********************************
  3.  
  4.   Thank you for using Programmer's SUPER-MAINT.  It has many features, and 
  5.   after you become comfortable using it you'll find it saves you much time
  6.   and effort in building your progamming projects.
  7.  
  8.  
  9.      This File is for the Shareware Trial Copy Version of SUPER-MAINT.
  10.              Use ORDER.FRM to Buy Your Registered Version.
  11. ****************************************************************************
  12.  
  13. **************[ A NOTE ABOUT OUR BULLETIN BOARD SYSTEM ]********************
  14.  
  15. As of February 1991 our Bulletin Board System (BBS) has been on line.  
  16. You may order any EmmaSoft product using the BBS, and registered users may 
  17. get technical support there.  In addition there is a growing collection of 
  18. shareware programs, most notably those written by Association of Shareware 
  19. Professionals authors.  There is no charge for accessing this board, and 
  20. downloads are unlimited (except by the daily time limit).  The EmmaSoft 
  21. BBS is an approved ASP BBS.
  22.  
  23. 607-533-7072    2400,1200,300bps    N,8,1    24 hours    No access Fee
  24.  
  25. ****************************************************************************
  26.  
  27. ******************[ The topics covered in this file are: ]******************
  28.  
  29.                 Disk Contents and Thanks
  30.                 1.  Installation*
  31.                 2.  New Since The Manual Was Printed
  32.                 3.  Upgrading from Earlier Versions
  33.                 4.  Compiler Support and Hardware Information*
  34.                 5.  The future
  35.                 6.  The sample program
  36.  
  37. *IMPORTANT NOTES:  You must read these sections to get started...
  38.  
  39. **********************[ DISK CONTENTS AND THANKS: ]**************************
  40.  
  41. If you got SUPER-MAINT on 5 1/4" disks you MUST have DISK#1 AND DISK#2.
  42. Both are contained on the 3 1/2" disk version.  
  43.  
  44. The following files MUST be included in your SUPER-MAINT package.  If 
  45. any of these are missing PLEASE CONTACT EMMASOFT IMMEDIATELY.
  46.  
  47.     DISK #1  (or SUPER30A.ZIP)
  48.  
  49.           DISK          ZIP   
  50.       --------    ---------
  51.         DISKID                 Validation File Required by Setup
  52.        ASP.TXT                 Shareware and ASP Information
  53.      ORDER.FRM                 Ordering Information and Form
  54.      README.SM                 This File
  55.      SETUP.EXE                 Automatic Setup Program
  56.      SETUP.HLP                 Help File For Setup Program
  57.       SMAK.EXE or   SMAK.ZIP   SUPER-MAINT Files
  58.   SMUPDATE.TXT                 A history of updates to SUPER-MAINT
  59.     SMUTIL.EXE or SMUTIL.ZIP   Help files, Sample Program, Manual
  60.     VENDOR.DOC                 Shareware Distribution Info for Vendors 
  61.                                and Sysops
  62.  
  63.     DISK #2   (OR SUPER30B.ZIP
  64.     (Setup lets you choose the appropriate configuration file and extracts
  65.     it for you.  You can extract the configurations manually by running the
  66.     appropriate self-extracting file below.)
  67.  
  68.    CONFIGS.EXE or CONFIGS.ZIP   Language definitions and script templates
  69.                                 for Borland C, Clipper, Mix, Manx, Microsoft 
  70.                                 C6 and earlier, Microsoft C7, SDK, Turbo C2,
  71.                                 Turbo C++, Watcom C, Zortech C, and the 
  72.                                 EmmaSoft demo bogus compilers.
  73.        MANUAL.SM            Operating Instructions
  74.  
  75. *****************[ Special thanks to the beta testers: ]*********************
  76.  
  77.       Don Bowen       (version 2)        Tom Bruce
  78.       Ross M. Greenberg                  Todd Hutchinson (version 1)
  79.       Eric Landes                        Ralph Mace      (version 2)
  80.       Allen Morris    (version 2)        Terry McConnel
  81.       Mike Ratledge                      Chip Rabinowitz
  82.       Peter Schulz    (version 2)        Dave Seidel
  83.       Vernon Six                         Mike Slater
  84.       Larry Weaver                       Adam Walker
  85.  
  86. Thanks for making SUPER-MAINT a better, more reliable program.
  87.  
  88. Special thanks to Chip Rabinowitz and Tom Bruce for major contributions,
  89. solutions, solace, and advice.
  90. *************************[ 1. INSTALLATION: ]*******************************
  91.  
  92. You should use SETUP.EXE to install SUPER-MAINT.  (You'll need approximately
  93. 351KB of free disk space to complete an installation.)  You must have DOS 
  94. version 3.0 or higher to insure SUPER-MAINT will work properly.   
  95.  
  96.    THE INSTALLATION PROGRAM WILL NOT TOUCH YOUR CONFIG.SYS FILE OR ANY 
  97.    OTHER FILES ON YOUR COMPUTER.  IF YOU CHOOSE TO LET SETUP UPDATE YOUR 
  98.    AUTOEXEC.BAT FILE IT WILL DO SO. 
  99.  
  100.                 On color systems type:       SETUP <Enter>
  101.            On monochrome systems type:       SETUP -m <Enter>
  102.  
  103. ****************************************************************************
  104. The first time you use SUPER-MAINT go into the setup menu to check your
  105. settings and type in your libraries.
  106. ****************************************************************************
  107.  
  108. SETUP.EXE does NOT copy itself, the compressed (self-extracting files), 
  109. or text files to your hard drive.  Only files that are needed to run 
  110. SUPER-MAINT are copied.
  111. ***************[ 2. New Since The Manual Was Printed: ]*********************
  112.  
  113. Chapter 5 (Chapter 3 in LITE manual):
  114. -------------------------------------
  115. TNAMES and Libraries as Dependents
  116.  
  117. When a library is included as a dependent on the TNAMES line it is also 
  118. added to the linker response file list of libraries to be linked.  If all
  119. libraries are added this way (no !L libraries) you must use a blank !L 
  120. statement for each memory model you use.
  121.  
  122. Chapter 7 (Chapter 5 in Lite Manual)
  123. ------------------------------------
  124.  
  125. *T can be used in the Linker, Librarian, and/or Compiler command groups
  126.  
  127. *CE is used (like *NE and *LE) to set a specific compiler response file 
  128. extension.
  129.  
  130. *RC can be used inside command groups.  If that group is being used the
  131. symbol defined there overrides the default symbol (usually @).
  132.  
  133. Appendix A:
  134. -----------
  135.  
  136. Questions and Answers (Continued)
  137.  
  138. Q:  I'm still not clear on when to use the *LCMND IS ___ statement in my 
  139.     make files?
  140. A:  You can take two approaches to a library make file.  A lot of people 
  141.     write them the same way as program make files:  using the object file
  142.     as the target for the code file that it is made of.  There's nothing 
  143.     wrong with this approach, but it means the object file must be present 
  144.     to operate on a library.  This may not be so safe if you are building 
  145.     more than one memory model of the same library.
  146.  
  147.     The other approach uses the library itself for all the targets.  The 
  148.     beauty of this approach is that if the library exists and the code has
  149.     not been updated, nothing has to happen regardless of the existence of
  150.     object files.  You can use -ea to erase the objs for each model you 
  151.     build (this isn't necessary if you are using -m*).  If the code HAS 
  152.     been updated, only that module has to be compiled and put into the 
  153.     existing library.  
  154.  
  155.     When using the latter approach (you thought I'd never answer your 
  156.     question!) SM needs a way of knowing which action block contains
  157.     the actual call to the librarian.  It can't use the target, because
  158.     ALL the targets are the library.  So you use the *LCMND IS ___ 
  159.     statement to let it know what the call to your librarian is:  when
  160.     it sees that in an action block SM knows to write the response file 
  161.     and build the library.
  162.  
  163. ****************[ 3. UPGRADING FROM EARLIER VERSIONS: ]*********************
  164.  
  165.                     ----RESPONSE FILE COMPATIBILITY-------
  166.  
  167. Version 3 of SUPER-MAINT generates response files on the fly.  You must 
  168. have additional information in your make file for this to work.  There are 
  169. two ways to deal with this for program building.
  170.  
  171. 1.  Add the new information to your make files.  This should be easy using
  172.     SME.  "Edit Old File," check your macros, name the files and 
  173.     SUPER-MAINT===>.
  174.  
  175. 2.  If you want to use your old make and response files as-is you will have
  176.     to call SM with the -lr- flag.  Before doing this you will need to 
  177.     rename your response files.  this is easy with the chgres utility 
  178.     provided.
  179.  
  180. Earlier versions linker response file extensions:  .LRS  .LRM .LRL
  181.        Version 3 linker response file extensions:  .LR1  .LR2 .LR3
  182.  
  183. To automatically change the extensions on your old response files go to 
  184. each directory you want to convert file names in and type:        
  185.  
  186.                              CHGRES <Enter>
  187.  
  188.                            -----Your Setup------
  189.  
  190. Do not try to use SUPER.INI files from old versions of SUPER-MAINT.  You
  191. will have to re-enter your library lists into the new version.
  192.  
  193.                        -----Language Definitions------
  194.  
  195. You will also have to change your language definitions files.  Use a text 
  196. editor to do the following to each one:  Down arrow 7 times.  At the first 
  197. character on the line press Enter.  Down arrow 1 more time and press enter 
  198. twice.  Now save the file.
  199.  
  200. Since SUPER.INI is different for version 3 you will have to re-enter your 
  201. libraries into the new version.  Do not try to use your old SUPER.INI file.
  202.  
  203. **************************[ 4.  COMPILER SUPPORT ]**************************
  204. ************************[ and Hardware Information ]************************
  205.  
  206. Version 3.00 and higher supports nearly any brand of Compiler thats linker 
  207. and librarian uses a response file.  Compiler configuration is contained 
  208. in a script file called TEMPLATE.SM.  Examples have been included for many 
  209. popular compilers.  If yours is not included you can make a script manually 
  210. (see Chapter 6 in the manual, and the template worksheet).
  211.  
  212. BRAND SPECIFIC NOTES:
  213.  
  214. Borland, Clipper and MIX users will want to include the full path when 
  215. setting library names in SME.
  216.  
  217. SPECIAL NOTE FOR USERS OF MIX POWER C:
  218.  
  219. When using the MIX librarian (MERGE.EXE) the name of the library must not
  220. be the same as the name of one of the modules in it.  This is because
  221. object modules and libraries both use the same (.MIX) extension.  
  222.  
  223. **************************************************************************
  224. * Please send us your configuration files if you have a compiler that is *
  225. * not included in the list of pre-written configurations.                *
  226. **************************************************************************
  227.  
  228. Users of SUPER-MAINT on Novell LANs have reported under some conditions
  229. the LAN time-stamps files with the server date and time regardless of that
  230. set on the work station.  Make utilities require that actual time/date 
  231. stamps be used.  If -er, -t or other flags are not working, check the time/
  232. date stamps the LAN is assigning to your files.
  233.  
  234. Notes for Aztec MANX C Support:
  235.  
  236.   The TEMPLATE.SM script has been set to make SME automatically add the -f 
  237.   command for calling response files.  Do not manually enter the command in 
  238.   a macro without changing the script or it will appear twice.
  239.  
  240.   Paths:
  241.  
  242.   Don't forget to set your *INCLUDE and *LIBRARY paths in TEMPLATE.SM before
  243.   you use SUPER-MAINT for the first time.
  244.  
  245.   Libraries:
  246.  
  247.   When setting up your libraries in the Setup menu you must type in the 
  248.   complete path, and include the file extension.  Example:
  249.  
  250.                      C:\LIBS\LMYLIB.LIB
  251.  
  252.   TEMPLATE.SM has two additional *AB commands to work with the ORD program.
  253.   This places two additional action blocks in the make file before the
  254.   action block that calls the librarian program.  The first changes the 
  255.   name of the xxxxxxxx.LR0 file, and the second passes it through ORD, 
  256.   renaming it to its original name.  Because the file needs to be there 
  257.   before the librarian needs it you should NOT use on-the-fly generation 
  258.   of library response files.  This means you will have to take out any 
  259.   @xxxxxxxx.LNK statements and replace the extension with "AZT" (or if you 
  260.   want another extension change the *AB commands in the template).
  261.  
  262.   Many thanks to Allen Morris for providing information about Aztec Manx C.
  263.  
  264. SDK (Software Development Kit for Microsoft Windows
  265.  
  266. TEMPLATE.SM has an *AB and an *AA command to call the resource compiler
  267. before and after linking.
  268.  
  269. BOGUS COMPILERS (DEMO Setup):
  270.  
  271. The "Demo" files were written for demonstrating Programmer's SUPER-MAINT at
  272. COMDEX.  The idea was to demonstrate the program without the overhead of
  273. a real compiler, assembler, etc.  The demonstration uses 5 programs: a
  274. bogus compiler, bogus assembler, bogus linker, bogus librarian, and a
  275. bogus debugger.  These and the requisite language definition files
  276. are placed on your disk when you choose "Demo" in SETUP.
  277.  
  278. The first two create bogus object files.  These are actually ascii files
  279. with the .OBJ extension.  The linker does the same, but creates a file 
  280. with the .EXE extension.  The librarian uses the .LIB extension.  All 
  281. take similar arguments to their Microsoft counterparts, but the arguments
  282. have no effect.  The one exception is the /CO argument for the linker.
  283. If you use /CO the ascii file starts with a line "Debugging Information 
  284. Included."  The Bogus Debugger reads the first letter of the bogus .EXE
  285. file.  If it is a "D" the debugger starts normally.  If not it displays
  286. a message that debugging information is not included.
  287.  
  288. If you want to try Programmer's SUPER-MAINT without using real compilers,
  289. etc. install the "Demo" files when SETUP.EXE asks "Who manufactures
  290. your compiler(s)?".  When you use SUPER-MAINT it will call the bogus
  291. programs to create bogus files.  Use the bogus debugger to see whether
  292. "debugging information" was included (as a test of the -d and -n flags).
  293.  
  294. IMPORTANT NOTE:  Do NOT try to run bogus .EXE files, and do NOT link
  295. bogus .OBJ or .LIB files into real programs!
  296.  
  297.         Bogus C Compiler:       EBCL.EXE
  298.         Bogus Assembler:        EBMASM.EXE
  299.         Bogus Linker:           EBLINK.EXE
  300.         Bogus Librarian:        EBLIB.EXE
  301.         Bogus Debugger:         EBDB.EXE
  302.  
  303.                              --------
  304.  
  305. ****************************[ 5.  THE FUTURE ]******************************
  306.  
  307. If there are features you would like in SUPER-MAINT please don't hesitate 
  308. to say so.  Please don't be angry at the program for not doing something 
  309. you want it to do.  Instead let us know what you want and there is a very 
  310. good chance it will be included in future versions.  We try to include as
  311. many users' suggestions into my programs as is reasonable (given the scope
  312. of the program).  So please keep those cards and letters coming!
  313.  
  314. *************************[ 6.  THE SAMPLE PROGRAM ]*************************
  315.  
  316. Included with this package is a set of sample files that you can use to
  317. experiment with.  These consist of:
  318.  
  319.   SAMPLE.C         C Code
  320.   SAMPLE1.C        C Code
  321.   SAMPLE2.C        C Code
  322.   SAMPLE.EXE       An executable version.
  323.  
  324. SAMPLE.EXE is a simple multi moduled program addition using C language.  
  325. It contains 5 functions.
  326.  
  327. To call it you type SAMPLE and two numbers (ex: SAMPLE 5 67).  It will
  328. add the numbers and report on whether it is exiting properly or with
  329. an error condition.
  330.  
  331. *********************[ Programmer's SUPER-MAINT ]***************************
  332. ***************************[ version 3.00 ]*********************************
  333. ************************[ End of README File ]******************************
  334.